Version: Development (main)

:::tip Experimental This documents unreleased main — not a released, committed API. See the API stability policy and use Stable instead. :::

Robotiq::ConditionVariable Class

Wait/notify handle: lets threads block until another thread signals.

Included Headers

#include <platform.hpp>

Public Destructor
	~ConditionVariable ()=default
Public Member Functions
void	waitUntil (Mutex &mutex, std::chrono::steady_clock::time_point timePoint)=0
	Unlock mutex, block until notified or timePoint passes, then relock it. More...
void	notifyAll () noexcept=0

virtual Robotiq::ConditionVariable::~ConditionVariable ()

virtual default

virtual void Robotiq::ConditionVariable::notifyAll ()

noexcept

Unblocks every thread currently waiting. Called from destructors, so it cannot throw; waking waiters has no failure worth reporting.

virtual void Robotiq::ConditionVariable::waitUntil	(	Mutex &	mutex,
		std::chrono::steady_clock::time_point	timePoint
	)

Unlock mutex, block until notified or timePoint passes, then relock it.

Parameters

mutex	The lockable object the caller holds; released while blocked.
timePoint	The point in time to return if not notified.

The documentation for this class was generated from the following file:

Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.9.8.